HandPartPose`1.xml

<Type Name="HandPartPose&lt;ContextType&gt;" FullName="Microsoft.Gestures.HandPartPose&lt;ContextType&gt;">
  <TypeSignature Language="C#" Value="public abstract class HandPartPose&lt;ContextType&gt; : Microsoft.Gestures.PoseConstraint where ContextType : GestureContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit HandPartPose`1&lt;(class Microsoft.Gestures.GestureContext) ContextType&gt; extends Microsoft.Gestures.PoseConstraint" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Gestures.HandPartPose`1" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Gestures</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <TypeParameters>
    <TypeParameter Name="ContextType">
      <Constraints>
        <BaseTypeName>Microsoft.Gestures.GestureContext</BaseTypeName>
      </Constraints>
    </TypeParameter>
  </TypeParameters>
  <Base>
    <BaseTypeName>Microsoft.Gestures.PoseConstraint</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Diagnostics.DebuggerDisplay("{DebuggerDisplay, nq}")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <typeparam name="ContextType">The context which the class is referring to. This is either a <see cref="T:Microsoft.Gestures.HandContext" /> or a <see cref="T:Microsoft.Gestures.FingersContext" />. A <see cref="T:Microsoft.Gestures.HandContext" /> type 
            parameter is used in <see cref="T:Microsoft.Gestures.PalmPose" /> to imply this child class represents a constraint relating to one or more hands. A <see cref="T:Microsoft.Gestures.FingersContext" /> type parameter is used in 
            <see cref="T:Microsoft.Gestures.FingerPose" /> to imply this child class represents a constraint relating to one or more fingers. To learn about the various available types of hand and fingers contexts,
            please refer to <seealso cref="T:Microsoft.Gestures.FingersContext" /> and <seealso cref="T:Microsoft.Gestures.HandContext" />.</typeparam>
    <summary>
            An abstract base class representing the pose of a hand part.
            </summary>
    <remarks>
      <para>
            Child classes of <see cref="T:Microsoft.Gestures.HandPartPose`1" /> are used to specify constraints describing the state of either the palm (e.g.: "the palm of the right hand is facing forward") - 
            see <seealso cref="T:Microsoft.Gestures.PalmPose" />, or the fingers (e.g. "the index, middle, ring and pinky fingers are folded") - see <seealso cref="T:Microsoft.Gestures.FingerPose" />.
            </para>
      <para>
            Every <see cref="T:Microsoft.Gestures.HandPartPose`1" /> has a <see cref="P:Microsoft.Gestures.HandPartPose`1.Context" /> associated with it. The <see cref="P:Microsoft.Gestures.HandPartPose`1.Context" /> specifies which concrete parts of the hand an instance of
            <see cref="T:Microsoft.Gestures.HandPartPose`1" /> relates to. For example, when dealing with a <see cref="T:Microsoft.Gestures.PalmPose" /> constraint, a <see cref="T:Microsoft.Gestures.SingleHandContext" /> context instantiated using the 
            <see cref="M:Microsoft.Gestures.SingleHandContext.#ctor(Microsoft.Gestures.Hand)" /> constructor with a <see cref="F:Microsoft.Gestures.Hand.RightHand" /> input argument would indicate that the <see cref="T:Microsoft.Gestures.PalmPose" /> constraint relates to the right hand. 
            Similarly, when dealing with a <see cref="T:Microsoft.Gestures.FingerPose" /> constraint, a <see cref="T:Microsoft.Gestures.SingleFingerContext" /> context instantiated using the <see cref="M:Microsoft.Gestures.SingleFingerContext.#ctor(Microsoft.Gestures.Finger)" /> constructor 
            with <see cref="F:Microsoft.Gestures.Finger.Pinky" /> input argument would indicate that the <see cref="T:Microsoft.Gestures.FingerPose" /> constraint relates to the pinky finger. To learn more about the various available types of 
            hand and fingers contexts, please refer to <seealso cref="T:Microsoft.Gestures.FingersContext" /> and <seealso cref="T:Microsoft.Gestures.HandContext" />.
            </para>
      <para>
            The <see cref="P:Microsoft.Gestures.HandPartPose`1.Direction" /> property describes the direction at which the hand part is pointing at. When dealing with a <see cref="T:Microsoft.Gestures.PalmPose" /> constraint, the <see cref="P:Microsoft.Gestures.HandPartPose`1.Direction" />
            refers to the palm normal (the direction perpendicular to the palm) and when dealing with a <see cref="T:Microsoft.Gestures.FingerPose" />, it refers to the direction of a finger (which is aligned with
            the distal phalanx of the finger).
            </para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected HandPartPose ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.#ctor" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected HandPartPose (ContextType context, Microsoft.Gestures.PoseDirection direction = Microsoft.Gestures.PoseDirection.Undefined);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(!ContextType context, valuetype Microsoft.Gestures.PoseDirection direction) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.#ctor(`0,Microsoft.Gestures.PoseDirection)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="context" Type="ContextType" />
        <Parameter Name="direction" Type="Microsoft.Gestures.PoseDirection" />
      </Parameters>
      <Docs>
        <param name="context">To be added.</param>
        <param name="direction">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CalculateHashCode">
      <MemberSignature Language="C#" Value="protected override int CalculateHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance int32 CalculateHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.CalculateHashCode" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Context">
      <MemberSignature Language="C#" Value="public ContextType Context { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance !ContextType Context" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Gestures.HandPartPose`1.Context" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>ContextType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Indicates which parts of the hand this constraint refers to: either <see cref="T:Microsoft.Gestures.SingleHandContext" />, <see cref="T:Microsoft.Gestures.AnyHandContext" /> or <see cref="T:Microsoft.Gestures.AllHandsContext" /> in case for a 
            <see cref="T:Microsoft.Gestures.PalmPose" /> constraint and either <see cref="T:Microsoft.Gestures.SingleFingerContext" />, <see cref="T:Microsoft.Gestures.AnyFingerContext" /> or <see cref="T:Microsoft.Gestures.AllFingersContext" /> for a <see cref="T:Microsoft.Gestures.FingerPose" />
            constraint.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DeepFreeze">
      <MemberSignature Language="C#" Value="protected override void DeepFreeze ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DeepFreeze() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.DeepFreeze" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DefaultPoseDirection">
      <MemberSignature Language="C#" Value="protected const Microsoft.Gestures.PoseDirection DefaultPoseDirection;" />
      <MemberSignature Language="ILAsm" Value=".field family static literal valuetype Microsoft.Gestures.PoseDirection DefaultPoseDirection" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Gestures.HandPartPose`1.DefaultPoseDirection" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Gestures.PoseDirection</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Direction">
      <MemberSignature Language="C#" Value="public Microsoft.Gestures.PoseDirection Direction { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Gestures.PoseDirection Direction" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Gestures.HandPartPose`1.Direction" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.ComponentModel.DefaultValue(Mono.Cecil.CustomAttributeArgument)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>System.ComponentModel.TypeConverter(typeof(Microsoft.Gestures.XamlTypeConverters.FlagEnumConverter))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Gestures.PoseDirection</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The direction of this hand part: Either the palm normal in case of a <see cref="T:Microsoft.Gestures.PalmPose" /> or the direction at which the fingers are pointing in case of a <see cref="T:Microsoft.Gestures.FingerPose" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EqualsInternal">
      <MemberSignature Language="C#" Value="protected override bool EqualsInternal (object other);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool EqualsInternal(object other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.EqualsInternal(System.Object)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="other">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.ToString" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Returns a string representation of this <see cref="T:Microsoft.Gestures.HandPartPose`1" /> instance.
            </summary>
        <returns>A string representation of this <see cref="T:Microsoft.Gestures.HandPartPose`1" /> instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ValidateCore">
      <MemberSignature Language="C#" Value="protected override void ValidateCore ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void ValidateCore() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Gestures.HandPartPose`1.ValidateCore" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Gestures</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>